/*
 * Copyright (c) 2011-2012 Alexander Dubu
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * o  Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * o  Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * o  Neither the name Axil nor the names of its contributors may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package axil.framework.format;

import axil.api.AxilObject;
import axil.api.Formatting;
import axil.api.Persona;

import static axil.framework.Functions.unimplemented;


/**
 * A formatting object that uses a mask, such as "000-00-0000" (for a SSN) or
 * "(000) 000-0000" (for a US phone number) as a specification. The special
 * characters recognized in a mask specification are:
 *
 * 	'0'	--	Indicates that a digit is always inserted, regardless of value.
 * 	'9'	--	Indicates that a digit is inserted, if present, or no character is
 * 			emitted at all.
 *	'Z' --	Indicates that a digit is inserted, if present, or a blank is
 *			inserted if there i no digit.
 *	'A'	--	Indicates that an alphabetic character is expected.
 *
 * All punctuation characters (":", "(", etc) are eliminated on input parsing
 * but are always shown on output formatting. When formatting, if the value
 * being formatted is a number, then formatting is filled right-to-left.
 * Otherwise, it is filled left-to-right.
 *
 * Content can be conditionally included by specifying the formatting characters
 * within "[]" characters. For example, the spec "(000) 000-0000 [EXT 999999]"
 * will only emit the "EXT" portion if at least one character is present.
 *
 * Finally, special characters, such as '9' or '[' can be forcibly included as
 * printing character by prefixing them with a '\' escape character.
 */
public class MaskFormatting implements Formatting {
	public MaskFormatting(String spec) {
		// TODO: Implement this method
		throw unimplemented();
	}


	/**
	 * Format the given value, returning a localized string suitable for
	 * presentation using the localized styling defined in this object.
	 *
	 * @param value
	 * 	The value to be formatted. The object given must be suitable for this
	 * 	formatting object; passing a type not suitable for this formatting
	 * 	specification will result in a run-time error. The value is never null.
	 *
	 * @param persona
	 * 	The persona (user) for which the value is to be formatted. The object
	 * 	given cannot be null. The persona is used for locale and timezone
	 * 	information.
	 *
	 * @return
	 * 	Returns a non-null string.
	 */
	public String format(AxilObject value, Persona persona) {
		// TODO: Implement this method
		throw unimplemented();
	}
}
